<?php

/*
 * Copyright (c) 2011 Antoine d'Otreppe de Bouvette
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

/**
 * A sane base for your loggers
 * 
 *  
 */
abstract class AbstractLogger implements Logger {
    /**
     * @var int
     */
    private $level;

    /**
     * @return int
     */
    public function getLevel() {
        return $this->level;
    }

    /**
     * @param int $level 
     */
    public function setLevel($level) {
        switch ($level) {
            case Logger::DEBUG:
            case Logger::WARNING:
            case Logger::ERROR:
                break;
            default:
                throw new RuntimeException(
                        "Log level must be one of the Logger constants.");
        }

        $this->level = $level;
    }

    /**
     * @param object $object
     * @param string $message 
     */
    public function debug($object, $message) {
        $this->maybeLog(Logger::DEBUG, $object, $message);
    }

    
    /**
     * @param object $object
     * @param string $message 
     */
    public function warning($object, $message) {
        $this->maybeLog(Logger::WARNING, $object, $message);
    }

    /**
     * @param object $object
     * @param string $message 
     */
    public function error($object, $message) {
        $this->maybeLog(Logger::ERROR, $object, $message);
    }

    /**
     * @param int $requiredLevel
     * @param object $object
     * @param string $message 
     */
    private function maybeLog($requiredLevel, $object, $message) {
        if ($requiredLevel >= $this->level) {
            $this->log($this->format($object, $message));
        }
    }

    /**
     *
     * @param object $object
     * @param string $message
     * @return string
     */
    private function format($object, $message) {
        return sprintf("[%s] %s -- %s\n", date('d M Y H:i:s'), get_class($object), $message);
    }

    /**
     * @param string $message
     */
    protected abstract function log($message);
}
